ODStorageSystem

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODStorageSystem

Superclasses
ODObject
Subclasses
none

An object of the ODStorageSystem class provides the functionality of the OpenDoc storage system.

Description
The OpenDoc storage system is a high-level persistent storage mechanism that enables multiple part editors to share a single document file effectively. When a document is opened, the session object creates a single storage-system object. All parts of that document share the storage-system object; you can obtain a reference to it by calling the session object's GetStorageSystem method (page 610).
The storage-system object creates and maintains a collection of container objects. Each container object can hold one or more document objects, each of which contains one or more draft objects. Each draft contains a number of storage unit objects, which hold streams of stored data.
Each container object has a container type and an identifier; these two characteristics together uniquely identify the container. OpenDoc supports both file containers and memory containers. File containers are persistent across sessions, whereas memory containers are transitory.
For more information related to container objects, see the ODContainer class description (page 98).

Methods
This section presents summary descriptions of the ODStorageSystem methods grouped according to purpose, followed by detailed descriptions in alphabetical order. Methods marked [D] are typically called by the document shell or container applications.
Container Manipulation

CreateContainer [D]
Creates a container object with the specified container type and identifier.
AcquireContainer [D]
Returns a reference to the container object with the specified container type and identifier.
Storage

CreatePlatformTypeList
Creates or copies a platform type list.
CreateTypeList
Creates or copies a type list.
Utility Routines

GetSession
Returns a reference to the current session object.
NeedSpace
Notifies this storage system to reserve memory for future use.

Methods
AcquireContainer
CreateContainer
CreatePlatformTypeList
CreateTypeList
GetSession
NeedSpace